refactor!: spell out abbreviated type names (Ctx→Context, Dict→Dictionary)#49
Merged
Conversation
Rename public types to full words, matching the Zstd<Compress|Decompress>
<Stream|Parameter> family and zstd prose ("compression context", "dictionary"):
- ZstdCompressCtx -> ZstdCompressContext
- ZstdDecompressCtx -> ZstdDecompressContext
- ZstdCompressDict -> ZstdCompressDictionary
- ZstdDecompressDict -> ZstdDecompressDictionary
Updates all code, tests, docs, README, benchmarks, smoke. luben (zstd-jni)
ZstdCompressCtx/Dict references in interop tests/benchmarks left untouched.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Rename the four abbreviated public types to full words, matching the existing
Zstd<Compress|Decompress><Stream|Parameter>family and zstd's own prose ("compression context", "dictionary"):ZstdCompressCtxZstdCompressContextZstdDecompressCtxZstdDecompressContextZstdCompressDictZstdCompressDictionaryZstdDecompressDictZstdDecompressDictionaryWhy
Ctx/Dictwere the only abbreviations left in the public surface —ZstdCompressParameter,ZstdCompressStream,ZstdDictionary,ZstdDictionaryIdalready spell out. zstd's C tokens abbreviate (CCtx/CDict) but its prose does not; this binding follows the prose. Java idiom favors full words.Scope
All main code, tests, docs, README, benchmarks, smoke, ADR. Breaking — noted in CHANGELOG
[Unreleased]; released history left intact.zstd-jni (luben) has its own
ZstdCompressCtx/ZstdDecompressCtx/ZstdCompressDict; those references in interop tests/benchmarks are deliberately untouched.Verification
./mvnw test— 261 unit + 81 integration, all green./mvnw javadoc:javadoc -pl zstd— zero output (cross-refs resolve)🤖 Generated with Claude Code